home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / OS2 / FM121WB.ZIP / FMOVE.DOC < prev    next >
Encoding:
Text File  |  1996-02-08  |  13.6 KB  |  296 lines

  1.         FMove 1.2 - Copyright 1993, 1996, Mike Walker. All rights reserverd.
  2.  
  3.        ┌──────────────────────────────────────────────────────────────────┐
  4.        │▒▒▒▒ Introduction ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  5.        └──────────────────────────────────────────────────────────────────┘
  6.  
  7.         Fmove is a utility used to move or kill files. Files may be
  8.         killed or moved based on number of days old or size. This utility
  9.         came about because I just got tired of looking for such a utility
  10.         myself. This is a protect mode dos app and needs rtm.exe in order
  11.         to run. I have included rtm inside the archive.
  12.  
  13.        ┌──────────────────────────────────────────────────────────────────┐
  14.        │▒▒▒▒ License and registration ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  15.        └──────────────────────────────────────────────────────────────────┘
  16.  
  17.         This program is Shareware. You may use this beta free of charge.
  18.         The license to use this beta version will expire upon the release
  19.         of the next version of Fmove. The release version will be distributed
  20.         as low cost shareware or freeware, I have not decided yet. :-)
  21.  
  22.         If the release version of Fmove is released as low cost shareware
  23.         a registration fee will be required for a license to use Fmove.
  24.  
  25.         Either way I will be willing to accept any donations in
  26.         appreciation for this work.
  27.  
  28.         You may not charge anything for this program other than a nominal
  29.         fee for the transfer of the program to the transfer media and the
  30.         cost of that media. You may distribute this program freely as
  31.         long as this document and all files contained in the original
  32.         archive remain in thier original state. The author reserves the
  33.         right to change this license argreement. 
  34.  
  35.         THE PROGRAM IS PROVIDED "AS-IS". NO WARRANTIES OF ANY KIND,
  36.         EXPRESS OR IMPLIED, ARE MADE AS TO IT OR ANY MEDIUM IT MAY
  37.         BE ON. NO REMEDY IS PROVIDED BY THE AUTHOR FOR INDIRECT,
  38.         CONSEQUENTIAL, PUNITIVE OR INCIDENTAL DAMAGES ARISING FROM
  39.         IT, INCLUDING SUCH FROM NEGLIGENCE, STRICT LIABILITY, OR
  40.         BREACH OF WARRANTY OR CONTRACT, EVEN AFTER NOTICE OF THE
  41.         POSSIBILITY OF SUCH DAMAGES. USE AT YOUR OWN RISK.
  42.  
  43.        ┌──────────────────────────────────────────────────────────────────┐
  44.        │▒▒▒▒ Installation ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  45.        └──────────────────────────────────────────────────────────────────┘
  46.  
  47.         Extract the archive to your utilities directory, or somewhere
  48.         specifed in the path. Once extracted you will need to create a
  49.         config file, or edit the sample configuration suppied. If you
  50.         have registered or have and evaluation version of fmove place
  51.         your key file in the same directory as fmove.exe. The key file
  52.         must be named fmove.key since this is name that fmove will look
  53.         for. Evaluation keys will expire and the expiry date will be
  54.         displayed when you run fmove.
  55.  
  56.        ┌──────────────────────────────────────────────────────────────────┐
  57.        │▒▒▒▒ Command Line Options ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  58.        └──────────────────────────────────────────────────────────────────┘
  59.  
  60.         -c Used to specify the config file to use.
  61.         -s Used to specify the schedule to run. (See schedules latter
  62.            in this doc).
  63.  
  64.         eg. Fmove -csample.cfg -sdostuff
  65.  
  66.        ┌──────────────────────────────────────────────────────────────────┐
  67.        │▒▒▒▒ The Config File ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  68.        └──────────────────────────────────────────────────────────────────┘
  69.  
  70.         The config file can be any name that you choose. When you
  71.         run the program you will need to specify the name on the
  72.         command line using the -c command line switch. If you do not
  73.         specify a config file name an attempt to read the default
  74.         fmove.cfg will be made. All commands within the should all
  75.         start in the first column of a line. Any line starting with
  76.         a semi-colon will be considered to be a comment. Do not place
  77.         comments at the end of command lines.The commands are divided
  78.         into two groups, global commands and action verbs. There is a
  79.         maximum of 255 action verbs that can be defined in the config
  80.         file. If this is not sufficient then you can use multiple
  81.         config files or schedules. Also keep in mind that the action
  82.         verbs are preformed in the order that they appear in the
  83.         config file. One last note, do not use trailing backslashes
  84.         for any of the paths defined for the action verbs.
  85.  
  86.        ┌──────────────────────────────────────────────────────────────────┐
  87.        │▒▒▒▒ Global Commands ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  88.        └──────────────────────────────────────────────────────────────────┘
  89.  
  90.         UserName
  91.  
  92.                 Syntax: UserName Your_Registered_Name
  93.  
  94.                 If you have a registration key you need to define the
  95.                 name that you used when registering, and use the key
  96.                 that was provided to you with the RegKey command. If
  97.                 you are using an evaluation version or beta of this
  98.                 program do not define a user name.
  99.  
  100.                 Note: Underscores must be used in place of spaces in
  101.                       your name for the UserName command.
  102.  
  103.         ArcFile Syntax: ArcFile FullPath
  104.  
  105.                 The ArcFile command is used for archiving
  106.                 descriptions of killed files. The file name that
  107.                 you use here is appended to when files are killed.
  108.                 Descriptions will also be moved to this file when
  109.                 Remiss is used.
  110.  
  111.         LogFile Syntax: LogFile FullPath
  112.  
  113.                 The Logfile command is used for logging program
  114.                 activity. The log that is created is a binkley style
  115.                 log.
  116.  
  117.         BBS     Syntax: [MAX3]|[FILESBBS]
  118.  
  119.                 Currently there are two possible values for this
  120.                 command. Max3 tells fmove to read maximus file areas
  121.                 by area name. FilesBBS tells fmove to use full path
  122.                 names to the file areas.
  123.  
  124.                 This command ditates how the move and kill commands
  125.                 area used. if the max3 mode is enabled using this
  126.                 command areas will be searched by area name. With
  127.                 max3 mode you will have to replace all paths names
  128.                 with the appropriate area name.
  129.  
  130.         BBSPath Syntax: BBSPath FullPath
  131.  
  132.                 Full path to the BBS system files. Only required for
  133.                 the Max3 support. Do not specify any file names here
  134.                 just the path to the BBS system files eg. D:\MAX
  135.  
  136.         ReIndex Syntax: ReIndex FullPath
  137.  
  138.                 This is the path to your file database build utility.
  139.                 eg. D:\MAX\FB.EXE
  140.  
  141.        ┌──────────────────────────────────────────────────────────────────┐
  142.        │▒▒▒▒ Action Verbs ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  143.        └──────────────────────────────────────────────────────────────────┘
  144.  
  145.         Move    Syntax:
  146.  
  147.                 Move [@]SourcePath TargetPath [-dDays] [-sMaxSize] [-kKeepDays]
  148.  
  149.                 This verb is used to move files from one area to
  150.                 another. The days portion of this command is
  151.                 optional. If you do not specify a number of days with
  152.                 the -d switch the number of days in the global section
  153.                 will be used. If the global command days was not used
  154.                 and the number of days was not specified for the move
  155.                 command, then all files in the source dir will be
  156.                 moved. The number of days for the move command will
  157.                 always take precidence over the global number of
  158.                 days.
  159.  
  160.                 The -sMaxSize switch is used to specify the maximum
  161.                 size of a file in bytes. If a file exceeds maxsize then
  162.                 it will be moved regardless of the number of days
  163.                 specified.
  164.                 
  165.                 The -kKeepDays switch is used to specify the number
  166.                 of days to keep files when they exceed maxsize. Using
  167.                 this switch will cause files that are oversize to be
  168.                 kept for the number of days defined with the keep days
  169.                 switch.
  170.  
  171.                 When moving files the descriptions in
  172.                 files.bbs are moved to the files.bbs at the target
  173.                 path.
  174.  
  175.                 The @ character is used to insert the source path
  176.                 at the beginning of the description in the target
  177.                 files.bbs.
  178.  
  179.         Kill    Syntax: Kill SourcePath [-dDays] [-sMaxSize] [-kKeepDays]
  180.  
  181.                 The kill verb works the same way as the move verb.
  182.                 Except that instead of moving files they are killed.
  183.                 The only difference in syntax is that you do not
  184.                 specify a target path. Be careful with this one,
  185.                 if used incorrectly you could end up killing files
  186.                 that you wanted to keep.
  187.  
  188.                 See documentation on the move command for explanation
  189.                 of the switches.
  190.  
  191.        ┌──────────────────────────────────────────────────────────────────┐
  192.        │▒▒▒▒ Misc Commands ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  193.        └──────────────────────────────────────────────────────────────────┘
  194.  
  195.         All of these commands may be used either as global commands or
  196.         within schedule blocks.
  197.  
  198.         Days    Syntax: Days 30
  199.  
  200.                 This command is used to specify the default number
  201.                 of days used by the action verbs. This command is
  202.                 optional.
  203.  
  204.         KeepOrg Syntax: KeepOrg (Defaults to off)
  205.  
  206.                 KeepOrg is used to keep the original description
  207.                 when moving or killing files. When this is used the
  208.                 description will not be removed from the source
  209.                 files.bbs file.
  210.  
  211.         Remiss  Syntax: Remiss (Defaults to off)
  212.  
  213.                 The remiss command is used to check for missing
  214.                 files when moving or killing files. If you use
  215.                 Remiss descriptions will be removed from files.bbs
  216.                 if the associated file is missing from the source
  217.                 directory. If you specify the ArcFile command then
  218.                 the descriptions will be placed in the ArcFile
  219.                 before removing them.
  220.  
  221.         Exclude Syntax: Exclude Mask
  222.  
  223.                 The Exclude verb is used to exclude files from the
  224.                 move and kill commands. The mask follows the normal
  225.                 dos conventions. For more information on file masks
  226.                 see your dos manual.
  227.  
  228.                 An example of this could be the following:
  229.  
  230.                 Exclude PK*.*
  231.                 Exclude *.SDN
  232.  
  233.                 This would cause Fmove not to move or kill any files
  234.                 that matched the file masks above.
  235.  
  236.        ┌──────────────────────────────────────────────────────────────────┐
  237.        │▒▒▒▒ Schedules ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  238.        └──────────────────────────────────────────────────────────────────┘
  239.  
  240.         Schedules are now supported with Fmove. A schedule is simply
  241.         a series of commands that are executed when the schedule is
  242.         invoked.
  243.  
  244.         To define a schedule there are two config verbs.
  245.         (Schedule, and EndSchedule).
  246.  
  247.         These two commands work as a pair to name and end schedules.
  248.         Any commands appearing in the config file before the first
  249.         schedule will be considered global commands. Global commands
  250.         are executed for all schedules. To envoke a schedule there
  251.         is a new command line option -s.
  252.  
  253.         When starting Fmove use the command line:
  254.  
  255.         Fmove -cfmove.cfg -sSchedule
  256.  
  257.         Where Schedule is the name of the schedule that you want to
  258.         run.
  259.  
  260.         Schedule Syntax: Schedule [ScheduleName]
  261.  
  262.                 This command starts the schedule. ScheduleName can be
  263.                 upto 32 characters in length. Any commands following
  264.                 the shedule command and before the next 'EndSchedule'
  265.                 will be considered part of that schedule.
  266.  
  267.         EndSchedule Syntax: EndSchedule
  268.  
  269.                 The EndSchedule command does not take any parameters,
  270.                 it simply ends the current schedule.
  271.  
  272.        ┌──────────────────────────────────────────────────────────────────┐
  273.        │▒▒▒▒ How to contact me ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  274.        └──────────────────────────────────────────────────────────────────┘
  275.  
  276.         I can be reached at any of the addresss below. Please report
  277.         any bugs that you find. If I don't know about the problem
  278.         chances are it will not be fixed.
  279.  
  280.          FidoNet: 1:153/809.0
  281.           SigNet: 25:9604/110
  282.         Internet: mike_walker@mindlink.bc.ca
  283.  
  284.         BBS: Arcadia BBS - 28.8 VFC
  285.               New Westminster, BC
  286.                    Canada
  287.  
  288.                (604) 526-5152
  289.  
  290.  
  291.         Note: If you are calling the BBS long distance and are using a USR
  292.               modem be wary. I do have the occasional problem with dropping
  293.               carriers upon receiving an inbound call from certain models
  294.               of USR modems. Since this is a problem I would not leave the
  295.               file request unattended.
  296.